Platform Explorer / Nuxeo Platform 2023.10

Extension point mapper

In component org.nuxeo.usermapper.service.UserMapperComponent

Documentation

Allow to contribute mapper classes that will be responsible for handling the mapping in 2 directions :

  • find and update NuxeoPrincipal given a userObject coming from the external system
  • create an external userObject from a NuxeoPrincipal

Here is an example to contribute a custom class : 

    <mapper class="org.nuxeo.usermapper.test.dummy.DummyUserMapper" name="javaDummy">
        <parameters>
            <parameter name="param1">value1</parameter>
        </parameters>
    </mapper>

The contributed class has to implement the UserMapper interface.

You can also contribute the implementation via a Groovy or JavaScript.

In this case, simply omit the class attribute and add a script tag: 

    <mapper name="scim" type="groovy">
        <mapperScript><![CDATA[
          import org.nuxeo.ecm.platform.usermanager.UserManager;
          import org.nuxeo.runtime.api.Framework;

              UserManager um = Framework.getService(UserManager.class);

              String userId = userObject.getId();
              if (userId == null || userId.isEmpty()) {
                userId = userObject.getUserName();
              }

              searchAttributes.put(um.getUserIdField(), userId);

              if (searchAttributes.containsKey("uid")) {
                userAttributes.put(um.getUserIdField(), searchAttributes.get("uid"));
              }

              if (userObject.getEmails() != null && userObject.getEmails().size() > 0) {
                userAttributes.put("email",userObject.getEmails().iterator().next().getValue());
              }
              String displayName = userObject.getDisplayName();
              if (displayName!=null && !displayName.isEmpty()) {
                int idx = displayName.indexOf(" ");
                if (idx>0) {
                    userAttributes.put("firstName", displayName.substring(0, idx).trim());
                    userAttributes.put("lastName", displayName.substring(idx+1).trim());
                } else {
                    userAttributes.put("firstName", displayName);
                    userAttributes.put("lastName", "");
                }
            }
            ]]></mapperScript>
        <wrapperScript><![CDATA[
          import org.nuxeo.ecm.core.api.DocumentModel;
          import org.nuxeo.ecm.core.api.NuxeoException;
          import org.nuxeo.ecm.platform.usermanager.UserManager;
          import org.nuxeo.runtime.api.Framework;

          import com.unboundid.scim.data.Entry;
          import com.unboundid.scim.data.GroupResource;
          import com.unboundid.scim.data.Meta;
          import com.unboundid.scim.data.Name;
          import com.unboundid.scim.data.UserResource;
          import com.unboundid.scim.schema.CoreSchema;
          import com.unboundid.scim.sdk.SCIMConstants;

              UserManager um = Framework.getService(UserManager.class);
              DocumentModel userModel = nuxeoPrincipal.getModel();
              String userId = (String) userModel.getProperty(um.getUserSchemaName(),
                      um.getUserIdField());

              String fname = (String) userModel.getProperty(um.getUserSchemaName(),
                      "firstName");
              String lname = (String) userModel.getProperty(um.getUserSchemaName(),
                      "lastName");
              String email = (String) userModel.getProperty(um.getUserSchemaName(),
                      "email");
              String company = (String) userModel.getProperty(um.getUserSchemaName(),
                      "company");

              String displayName = fname + " " + lname;
              displayName = displayName.trim();
              userObject.setDisplayName(displayName);
              Collection<Entry<String>> emails = new ArrayList<>();
              if (email!=null) {
                  emails.add(new Entry<String>(email, "string"));
                  userObject.setEmails(emails);
              }

              Name fullName = new Name(displayName, lname, "", fname, "", "");
              userObject.setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
                      "name", Name.NAME_RESOLVER, fullName);

              // manage groups
              List<String> groupIds = um.getPrincipal(userId).getAllGroups();
              Collection<Entry<String>> groups = new ArrayList<>();
              for (String groupId : groupIds) {
                  groups.add(new Entry<String>(groupId, "string"));
              }
              userObject.setGroups(groups);

              userObject.setActive(true);
            ]]></wrapperScript>
    </mapper>
    <mapper name="jsDummy" type="js">
        <mapperScript>
              searchAttributes.put("username", userObject.login);
              userAttributes.put("firstName", userObject.name.firstName);
              userAttributes.put("lastName", userObject.name.lastName);
              profileAttributes.put("userprofile:phonenumber", "555.666.7777");
          </mapperScript>
    </mapper>

In the script context for mapping userObject to NuxeoPrincipal :

  • userObject : represent the object passed to the 
    getCreateOrUpdateNuxeoPrincipal
    method
  • searchAttributes : is the Map<String,String> that will be used to search the NuxeoPrincipal
  • userAttributes : is the Map<String,String> that will be used to create/update the NuxeoPrincipal
  • profileAttribute : is the Map<String,String> that will be used to update the user's profile

In the script context for wrapping a NuxeoPrincipal into a userObject :

  • userObject : represent the userObject as initialized by the caller code
  • nuxeoPrincipal : is the principal to wrap
  • params : is the Map<String,Serializable> passed by the caller

Contribution Descriptors

  • Class: org.nuxeo.usermapper.service.UserMapperDescriptor

Contributions

No known contributions.